POST api/report/range/{authenticationToken}

This method is used to return a loan report based on a date range for when loans were created.

Request Information

URI Parameters

Name	Description	Type	Additional information
authenticationToken	Current authentication token	string	Required

Body Parameters

Identifies the desired range of dates.

ReportRangeModel

Name	Description	Type	Additional information
StartDateTime	This property is the desired starting date for range determination. If the date is not a valid date, then this property is ignored and no minimum start date is used.	date	None.
EndDateTime	This property is the desired ending date for range determination. If the date is not a valid date, then this property is ignored and no maximum end date is used.	date	None.
UseLastModified	This property is used to determine if the report is based on the date the loan was created or on the date the loan was last modified. Passing in "true" will use the last modified date while "false" will use the date the loan was created.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "StartDateTime": "2025-07-07T05:11:17.5512771-05:00",
  "EndDateTime": "2025-07-07T05:11:17.5512771-05:00",
  "UseLastModified": true
}

application/xml, text/xml

Sample:

<ReportRangeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <EndDateTime>2025-07-07T05:11:17.5512771-05:00</EndDateTime>
  <StartDateTime>2025-07-07T05:11:17.5512771-05:00</StartDateTime>
  <UseLastModified>true</UseLastModified>
</ReportRangeModel>

application/x-www-form-urlencoded

Sample:

StartDateTime=value&EndDateTime=value&UseLastModified=value

Response Information

Resource Description

A report of desired loans.

Collection of ReportModel

Name	Description	Type	Additional information
LoanKey	This property is the internal loan key for the loan.	string	None.
LoanId	This property is the public loan identifier (loan number) for the loan.	string	None.
DateTimeCreated	This property is the date and time the loan was created.	date	None.
StatusAlias	This is the status alias (short description) for the status currently on the loan.	string	None.
StatusDescription	This property is the full status description for the status currently on the loan.	string	None.
StatusDateTime	This property is the date and time the loan was moved to the current status.	date	None.
DateLastModified		date	None.
IsCompleted	This property indicates whether the loan's current status is a "completed" or "final" status.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "LoanKey": "sample string 1",
    "LoanId": "sample string 2",
    "DateTimeCreated": "2025-07-07T05:11:17.5669413-05:00",
    "StatusAlias": "sample string 4",
    "StatusDescription": "sample string 5",
    "StatusDateTime": "2025-07-07T05:11:17.5669413-05:00",
    "DateLastModified": "2025-07-07T05:11:17.5669413-05:00",
    "IsCompleted": true
  },
  {
    "LoanKey": "sample string 1",
    "LoanId": "sample string 2",
    "DateTimeCreated": "2025-07-07T05:11:17.5669413-05:00",
    "StatusAlias": "sample string 4",
    "StatusDescription": "sample string 5",
    "StatusDateTime": "2025-07-07T05:11:17.5669413-05:00",
    "DateLastModified": "2025-07-07T05:11:17.5669413-05:00",
    "IsCompleted": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfReportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <ReportModel>
    <DateLastModified>2025-07-07T05:11:17.5669413-05:00</DateLastModified>
    <DateTimeCreated>2025-07-07T05:11:17.5669413-05:00</DateTimeCreated>
    <IsCompleted>true</IsCompleted>
    <LoanId>sample string 2</LoanId>
    <LoanKey>sample string 1</LoanKey>
    <StatusAlias>sample string 4</StatusAlias>
    <StatusDateTime>2025-07-07T05:11:17.5669413-05:00</StatusDateTime>
    <StatusDescription>sample string 5</StatusDescription>
  </ReportModel>
  <ReportModel>
    <DateLastModified>2025-07-07T05:11:17.5669413-05:00</DateLastModified>
    <DateTimeCreated>2025-07-07T05:11:17.5669413-05:00</DateTimeCreated>
    <IsCompleted>true</IsCompleted>
    <LoanId>sample string 2</LoanId>
    <LoanKey>sample string 1</LoanKey>
    <StatusAlias>sample string 4</StatusAlias>
    <StatusDateTime>2025-07-07T05:11:17.5669413-05:00</StatusDateTime>
    <StatusDescription>sample string 5</StatusDescription>
  </ReportModel>
</ArrayOfReportModel>